Get measure overlay properties
{ getMeasureOverlay }
Gets measure overlays for the given role for a model
Method
/API3/dataSources/getMeasureOverlay
- Enterprise Admin
- Domain Admin
Input Parameters
Name
getOverlaySecurityObject
Object Type
Description
An object representing the data model overlay / security.
Output Response
Successful Result Code
200
Response List Type
Description of Response Type
List of the measure overlays for the model and the role.. Note that the response is returned as a list of items of this object type.
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/dataSources/getMeasureOverlay" \
-d '{
"modelId" : "modelId",
"roleId" : "roleId"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;
import java.util.*;
import java.time.*;
public class DataSourcesServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
// Initialize the getOverlaySecurityObject parameter object for the call
GetOverlaySecurityObject getOverlaySecurityObject = ; // Create the input object for the operation, type: GetOverlaySecurityObject
try {
// "array[MeasureOverlayData]" is only psaudo-code to symbolize list of type and not the actual usage
array[MeasureOverlayData] result = apiInstance.getMeasureOverlay(getOverlaySecurityObject);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataSourcesServiceApi#getMeasureOverlay");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const getOverlaySecurityObject = ; // {GetOverlaySecurityObject}
api.getMeasureOverlay(getOverlaySecurityObject).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class getMeasureOverlayExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new DataSourcesServiceApi();
// Initialize the getOverlaySecurityObject parameter object for the call
var getOverlaySecurityObject = new GetOverlaySecurityObject(); // GetOverlaySecurityObject |
try {
// Gets measure overlays for the given role for a model
// "array[MeasureOverlayData]" is only psaudo-code to symbolize array of type and not the actual usage
array[MeasureOverlayData] result = apiInstance.getMeasureOverlay(getOverlaySecurityObject);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DataSourcesServiceApi.getMeasureOverlay: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = DataSourcesServiceApi(api_client)
# Initialize the getOverlaySecurityObject parameter object for the call
getOverlaySecurityObject = # GetOverlaySecurityObject |
try:
# Gets measure overlays for the given role for a model
api_response = api_instance.get_measure_overlay(getOverlaySecurityObject)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataSourcesServiceApi->getMeasureOverlay: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$getOverlaySecurityObject = ; // GetOverlaySecurityObject |
try {
$result = $api_instance->getMeasureOverlay($getOverlaySecurityObject);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataSourcesServiceApi->getMeasureOverlay: ', $e->getMessage(), PHP_EOL;
}
?>